“Live Audio Announcer” Documentation by “MohamedKaram” v1.0
“Live Audio Announcer”
Created: 9/1/2011
By: MohamedKaram
Email: mohamed_karam@live.com
Thank you for purchasing my Plugin. If you have any questions that are beyond the scope of this help file, please feel free to email via my user page contact form here. Thanks so much!
Table of Contents:
- Installation Steps - getting started
- Database Setup
- WebPages Setup
- Admin Panel
- How to Use
- Sources and Credits
Quick start guide - top
The Live Audio Announcer is a php system that can be used inside your website to give you the ability to post Audio notifications, Announcements, Music, sound effects to your users But this time you can do that in RealTime!, which means that while the user is browsing your pages he can hear the announcements without having to reload the page.
What u have to do, (in a brief discription) is that after installing the system, u will have to put the mp3 files that contains the audio announcements, in the website folder, and through the admin panel, u just write the path to that file, and press play. You will also be able to store more than one announcement, such that u can play/stop them later without having to write their file paths everytime u visit the admin panel.
- Have an unlimited number of announcements.
- User Friendly and easy to use admin panel.
- Very Easy Setup Steps.
in the following Section you will learn how to install the item, and how to use it. so just follow the steps :
A) Installation Steps - getting started - top
Upload all the CONTENTS (files and folders) inside the "Live Audio Announcer V1" folder to your server.
B) Database - top
Well, in order to install the Database, you have to import the announcer.SQL -(which you can find in the "Database" folder)- to your database in the PHPmyAdmin panel
Note: if you don't have PhpMyAdmin then you just have to copy the contents of announcemer.SQL to your Mysql interface query page and execute them.
After that, Go to INC/Config.php lines 6-9, you will find the following lines, change their values with your database information
- $database = ''; // database name
- $host = 'localhost'; // this is the location of the database server (usually kept unchanged)
- $db_user = 'root'; // this is the username of the database adminstrator account (which you will set through the php interface)
- $db_pass = ''; // this is the password of the database adminstrator account (which you will set through the php interface)
C) HTML Structure - top
for each page which you want to run the announcer on, just write the following line in the HEAD section (make sure that u write that line between the HEAD tags)
<?php require_once("inc/mkinclude.php"); ?>
D) Using the admin panel - top
when you open the admin panel index.php, you will be asked to login as adminstrator, the default initial username/password are:
- Username : admin
- Password : demo
after you login you will be on the home page, which shows the current stored announcements.
The admin panel's home page looks like the following:
- File name: the file path of the announcement audio file
- Live Play/Stop: shows the current state of the announcement, and by clicking on the symbol u can change the state from stop to play or play to stop.
- Edit: click on it in order to change the values of any of the corresponding announcements
- Delete: click on it in order to delete that announcement.
for adding a new announcement, just click on "add announcement" from the top menu. and it will take you to the following page:
- Audio File : fill it with file path of the audio file, from the point of view of the webpage file.
The last thing, in order to change your username or password: click on "change login" from the top menu, and it will take you to the following page:
at that page, you can input the old/new username or the old/new password or both of them, so you can change your login information. if you don't want to change one of them (SIMPLY LEAVE IT BLANK)
E) How to use: - top
After installing the plugin successfully, here are the steps to get it to work:
- First of all, each page u r going to use the plugin on, should be .php NOT .html
- Now, u have to put the Audio files which contain the Notifications, somewhere on the webserver, e.g: (in a folder called "announcements" beside the webpages)
- in the admin panel, click Add announcements, then write the path to that file, in the above case it would be : announcements/filename.mp3
- In the current announcements page, u will find that entry has been added, u can now click on "play/stop" button, to play or stop the announcement live.
- Note: it you left the play button on, each time a user will enter the website will hear the announcement, as well as the users who are already on the site when u pressed play.
- if u don't want that, then after the duration of that announcement, u can click stop at anytime, so that it won't be played again for new users who will visit the website Later.
F) Sources and Credits - top
Many Thanks to:
- You! :)
- Jquery
- Mysql
Once again, thank you so much for purchasing this plugin. As I said at the beginning, I'd be glad to help you if you have any questions relating to this plugin. I'll do my best to assist.
MohamedKaram